feat(commit): implement questions 'filter' support with handlers #1207

AdrianDC · 2024-08-13T17:23:46Z

Description

Supported APIs: Common Python, commitizen.cz.utils.* functions

Example YAML configurations:

commitizen:
  name: cz_customize
  customize:
    questions:
      - ...
      - type: input
        name: scope
        message: 'Scope of the change :'
        filter: 'lambda text: commitizen.cz.utils.required_validator(text, msg="! Error: Scope is required")'
        default: ''
      - type: input
        name: subject
        message: 'Title of the commit (starting in lower case and without period) :'
        filter: 'lambda text: commitizen.cz.utils.required_validator(text.strip(".").strip(), msg="! Error: Title is required")'
        default: ''
      - type: input
        name: body
        message: 'Additional contextual message (Empty to skip) :'
        default: 'Issue: #...'
        filter: 'commitizen.cz.utils.multiple_line_breaker'

Additional commits to add missing YAML tests, fix YAML configurations, and then add the keys for this feature.

Checklist

Add test cases to all the changes you introduce
Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
Test the changes on the local machine manually
Update the documentation for the changes

Expected behavior

? Title of the commit (starting in lower case and without period) :                                                                                                                                                                                    
Hello                                                                                                                                                                                                                                                  
! Error: Title is required

Steps to Test This Pull Request

Example provided in the description

Additional context

codecov · 2024-08-13T17:35:35Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.26%. Comparing base (120d514) to head (e01b323).
⚠️ Report is 805 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1207      +/-   ##
==========================================
+ Coverage   97.33%   98.26%   +0.92%     
==========================================
  Files          42       58      +16     
  Lines        2104     2712     +608     
==========================================
+ Hits         2048     2665     +617     
+ Misses         56       47       -9

Flag	Coverage Δ
unittests	`98.26% <100.00%> (+0.92%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

AdrianDC · 2024-08-17T00:51:35Z

Coverage resolved, 100% over commit.py
TOML faulty types fixed
Local containerized tests fixed for 'safe.directory' ownership issues
Tests for 'cz_customize' using the .customize config rather than unrelated cz_jira
Contents of the questions prompts tested for coverage and types around commands.Commit

commitizen/commands/commit.py

Lee-W

I'm sending a "Request changes" to this PR as I'm -1 to this but would like to get feedback from other maintainers

AdrianDC · 2024-08-25T03:43:32Z

Refactored as discussed : feat(commit): implement questions 'filter' support with handlers

Supported APIs:

multiple_line_breaker
required_validator
required_validator_scope
required_validator_subject_strip
required_validator_title_strip

Example YAML configurations:

commitizen:
  name: cz_customize
  customize:
    questions:
      - ...
      - type: input
        name: scope
        message: 'Scope of the change :'
        filter: 'required_validator_scope'
        default: ''
      - type: input
        name: subject
        message: 'Title of the commit (starting in lower case and without period) :'
        filter: 'required_validator_subject_strip'
        default: ''
      - type: input
        name: body
        message: 'Additional contextual message (Empty to skip) :'
        default: 'Issue: #...'
        filter: 'multiple_line_breaker'

AdrianDC · 2024-12-13T22:36:10Z

Rebased 😉 .

Please cherry-pick at least the coverage improvements and minor fixes before the filter features review 👍 .

Lee-W

Sorry for taking so long. Just left some comments

docs/customization.md

scripts/test

commitizen/cz/utils.py

Lee-W · 2025-06-08T14:56:23Z

I'll come back to this one after 4.8.3 release. As for another PR, I'll take a look at these 2 days. Sorry for the long waiting and thanks so much for still being around!

Signed-off-by: Adrian DC <[email protected]>

> commitizen.exceptions.InvalidConfigurationError: Failed to parse not_exist.yaml: while scanning a double-quoted scalar > found unknown escape character 's' Signed-off-by: Adrian DC <[email protected]>

> test_commit_parser[config2] - AssertionError: > assert '(?P<message>.*)' == '^(?P<change_...<message>.*)?' > test_changelog_pattern[config2] - AssertionError: > assert '.*' == '^(feature|bug fix)?(!)?' > test_change_type_map[config2] - AssertionError: > assert None == {'bug fix': 'Fix', 'feature': 'Feat'} Signed-off-by: Adrian DC <[email protected]>

Details: If using a TOML configuration, the type was 'tomlkit.items.AoT' --- Signed-off-by: Adrian DC <[email protected]>

Signed-off-by: Adrian DC <[email protected]>

Supported APIs: - multiple_line_breaker - required_validator - required_validator_scope - required_validator_subject_strip - required_validator_title_strip Example YAML configurations: --- commitizen: name: cz_customize customize: questions: - ... - type: input name: scope message: 'Scope of the change :' filter: 'required_validator_scope' default: '' - type: input name: subject message: 'Title of the commit (starting in lower case and without period) :' filter: 'required_validator_subject_strip' default: '' - type: input name: body message: 'Additional contextual message (Empty to skip) :' default: 'Issue: #...' filter: 'multiple_line_breaker' --- Signed-off-by: Adrian DC <[email protected]>

Signed-off-by: Adrian DC <[email protected]>

AdrianDC · 2025-09-14T17:28:45Z

Rebased from last year's PR, to update towards 4.9.1+adriandc.20250914
for pre-commit-crocodile 8.0.0 (prek becoming default btw).

Feel free to edit the PR or cherry-pick at will.

I also implemented a check-commitizen-branch wrapper to the commitizen-branch hook,
handling set-head if needed, covering #704, also #593, but fixing upstream needs analysis.

For the record, I'm not a fan of pinning to a patched & customized fork for so long,
blocking my users + coworkers on a specific version of commitizen-tools that I rebase 2-3 times a year,
including now v5-moved fixes and questions features, but works fine since August 2024.

AdrianDC requested review from Lee-W, noirbizarre and woile as code owners August 13, 2024 17:23

github-actions bot added the pr-status: wait-for-review label Aug 13, 2024

AdrianDC force-pushed the questions-filter branch from c120cae to 5a661cf Compare August 13, 2024 17:25

AdrianDC mentioned this pull request Aug 16, 2024

fix(pre-commit-hooks)!: allow empty ranges in 'commitizen-branch' #1209

Merged

4 tasks

AdrianDC force-pushed the questions-filter branch 3 times, most recently from e04ce53 to 5011a91 Compare August 17, 2024 00:33

AdrianDC force-pushed the questions-filter branch 2 times, most recently from 780b16b to c24db8a Compare August 18, 2024 13:38

Lee-W requested changes Aug 22, 2024

View reviewed changes

commitizen/commands/commit.py Outdated Show resolved Hide resolved

Lee-W requested changes Aug 22, 2024

View reviewed changes

Lee-W added pr-status: wait-for-response and removed pr-status: wait-for-review labels Aug 22, 2024

Lee-W assigned noirbizarre and woile Aug 22, 2024

AdrianDC force-pushed the questions-filter branch from c24db8a to d4d089e Compare August 25, 2024 01:59

github-actions bot added the pr-status: wait-for-review label Aug 25, 2024

AdrianDC force-pushed the questions-filter branch from d4d089e to 968a900 Compare August 25, 2024 02:00

AdrianDC changed the title ~~feat(commit): implement questions 'filter' support with evaluations~~ feat(commit): implement questions 'filter' support with handlers Aug 25, 2024

AdrianDC force-pushed the questions-filter branch 2 times, most recently from 65f4d93 to 314f3bf Compare August 25, 2024 03:38

AdrianDC force-pushed the questions-filter branch 2 times, most recently from 8e411f3 to 33bbf0f Compare November 16, 2024 15:13

Lee-W self-requested a review November 18, 2024 14:44

Lee-W removed the pr-status: wait-for-response label Nov 18, 2024

AdrianDC force-pushed the questions-filter branch from 33bbf0f to d0307fc Compare December 13, 2024 22:34

Lee-W reviewed Jan 30, 2025

View reviewed changes

docs/customization.md Show resolved Hide resolved

scripts/test Outdated Show resolved Hide resolved

commitizen/cz/utils.py Outdated Show resolved Hide resolved

commitizen/cz/utils.py Outdated Show resolved Hide resolved

Lee-W added pr-status: wait-for-modification type: feature A new enhacement proposal and removed pr-status: wait-for-review labels Jan 30, 2025

AdrianDC mentioned this pull request Jun 8, 2025

test(cz_customize): add missing YAML configuration file tests #1516

Open

AdrianDC force-pushed the questions-filter branch from d0307fc to 2759cab Compare June 8, 2025 14:37

github-actions bot added the pr-status: wait-for-review label Jun 8, 2025

Lee-W added this to the 4.9.0 milestone Jun 8, 2025

Lee-W assigned Lee-W and unassigned noirbizarre and woile Jun 8, 2025

Lee-W self-requested a review June 8, 2025 14:55

Lee-W removed the pr-status: wait-for-review label Aug 24, 2025

Lee-W modified the milestones: 4.9.0, 4.10.0 Sep 9, 2025

AdrianDC added 7 commits September 14, 2025 18:37

test(cz_customize): add missing YAML configuration file tests

67634e3

Signed-off-by: Adrian DC <[email protected]>

test(cz_customize): fix YAML test and docs configurations quotes

9d4a673

> commitizen.exceptions.InvalidConfigurationError: Failed to parse not_exist.yaml: while scanning a double-quoted scalar > found unknown escape character 's' Signed-off-by: Adrian DC <[email protected]>

fix(commit): ensure 'questions' is a Python dictionary and not TOML

f535274

Details: If using a TOML configuration, the type was 'tomlkit.items.AoT' --- Signed-off-by: Adrian DC <[email protected]>

test(cz_customize): use 'cz_customize' configurations in its tests

8d72597

Signed-off-by: Adrian DC <[email protected]>

chore(utils): rework 'multiple_line_breaker' into 'break_multiple_line'

e01b323

Signed-off-by: Adrian DC <[email protected]>

AdrianDC force-pushed the questions-filter branch from 2d70c25 to e01b323 Compare September 14, 2025 17:17

github-actions bot added the pr-status: wait-for-review label Sep 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(commit): implement questions 'filter' support with handlers #1207

feat(commit): implement questions 'filter' support with handlers #1207

Uh oh!

AdrianDC commented Aug 13, 2024

Uh oh!

codecov bot commented Aug 13, 2024 •

edited

Loading

Uh oh!

AdrianDC commented Aug 17, 2024

Uh oh!

Uh oh!

Lee-W left a comment

Uh oh!

AdrianDC commented Aug 25, 2024

Uh oh!

AdrianDC commented Dec 13, 2024

Uh oh!

Lee-W left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lee-W commented Jun 8, 2025

Uh oh!

AdrianDC commented Sep 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

feat(commit): implement questions 'filter' support with handlers #1207

Are you sure you want to change the base?

feat(commit): implement questions 'filter' support with handlers #1207

Uh oh!

Conversation

AdrianDC commented Aug 13, 2024

Description

Checklist

Expected behavior

Steps to Test This Pull Request

Additional context

Uh oh!

codecov bot commented Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

AdrianDC commented Aug 17, 2024

Uh oh!

Uh oh!

Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

AdrianDC commented Aug 25, 2024

Uh oh!

AdrianDC commented Dec 13, 2024

Uh oh!

Lee-W left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lee-W commented Jun 8, 2025

Uh oh!

AdrianDC commented Sep 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Aug 13, 2024 •

edited

Loading